feat(browser): Detect redirects when emitting navigation spans #16324
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
size-limit report 📦
|
❌ Unsupported file format
|
mydea
force-pushed
the
fn/detect-pageload-redirects
branch
2 times, most recently
from
ccbd697 to
eb3c0bc
Compare
s1gr1d
approved these changes
May 23, 2025
| if (getClient() !== client) { | ||
| return; | ||
| } | ||
|
|
||
| if (navigationOptions?.isRedirect) { | ||
| DEBUG_BUILD && logger.warn('[Tracing] Detected redirect, navigation span will not be the root span.'); |
There was a problem hiding this comment.
Suggested change
| DEBUG_BUILD && logger.warn('[Tracing] Detected redirect, navigation span will not be the root span.'); | |
| DEBUG_BUILD && logger.warn('[Tracing] Detected redirect, navigation span will not be the root span, but a child span.'); |
mydea
force-pushed
the
fn/detect-pageload-redirects
branch
from
eb3c0bc to
cb8e92e
Compare
edwardgou-sentry
approved these changes
Jun 5, 2025
| @@ -371,6 +396,10 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio | |||
| startTrackingInteractions(); | |||
| } | |||
|
|
|||
| if (detectRedirects && optionalWindowDocument) { | |||
| addEventListener('click', () => (lastClickTimestamp = timestampInSeconds()), { capture: true, passive: true }); | |||
There was a problem hiding this comment.
are there other events, such as key presses, that could indicate a user manually navigating?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #15286
This PR adds a new option to
browserTracingIntegration,detectRedirects, which is enabled by default. If this is enabled, the integration will try to detect if a navigation is actually a redirect based on a simple heuristic, and in this case, will not end the ongoing pageload/navigation, but instead let it run and create anavigation.redirectzero-duration span instead.An example trace for this would be: https://sentry-sdks.sentry.io/explore/discover/trace/95280de69dc844448d39de7458eab527/?dataset=transactions&eventId=8a1150fd1dc846e4ac8420ccf03ad0ee&field=title&field=project&field=user.display&field=timestamp&name=All%20Errors&project=4504956726345728&query=&queryDataset=transaction-like&sort=-timestamp&source=discover&statsPeriod=5m×tamp=1747646096&yAxis=count%28%29
Where the respective index route that triggered this has this code:
The used heuristic is:
this limit was chosen somewhat arbitrarily, open for other suggestions too.
While this logic will not be 100% bullet proof, it should be reliable enough and likely better than what we have today. Users can opt-out of this logic via
browserTracingIntegration({ detectRedirects: false }), if needed.